| Property | Value |
| Model name | petstore |
| Technical name | |
| Description | This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key |
| Synchronization Id | |
| Target | OpenAPI |
| Target version | 3.0.0 |
| info | |
| title | Swagger Petstore |
| terms of service | http://swagger.io/terms/ |
| contact | |
| name | |
| url | |
| apiteam@swagger.io | |
| extensions | |
| license | |
| name | Apache 2.0 |
| url | http://www.apache.org/licenses/LICENSE-2.0.html |
| extensions | |
| version | 1.0.0 |
| info extensions | |
| servers | |
| [1] url | http://petstore.swagger.io/v2 |
| description | |
| variables | |
| extensions | |
| security | |
| tags | |
| [1] name | pets |
| description | Everything about your Pets |
| externalDocs | |
| extensions | |
| [2] name | stores |
| description | Find out more |
| externalDocs | |
| extensions | |
| [3] name | users |
| description | More about users |
| externalDocs | |
| extensions | |
| externalDocs | |
| url | http://swagger.io |
| description | Find out more about Swagger |
| extensions | |
| extensions | |
| [1] pattern | x-origin |
| value | { "url": "http://petstore.swagger.io/v2/swagger.json", "format": "swagger", "version": "2.0", "converter": { "url": "https://github.com/mermade/swagger2openapi", "version": "2.2.0" } } |
| Lineage capture | |
| Polyglot models | |
| Comments | |
| Field | Type | Req | Key | Description | Comments |
| Order | object | false | |||
| Category | object | false | |||
| User | object | false | |||
| Tag | object | false | |||
| Pet | object | false | |||
| ApiResponse | object | false |
| Property | Value |
| Name | schemas |
| Technical name | |
| Type | componentObject |
| Field | Type | Req | Key | Description | Comments |
| id | integer | false | |||
| petId | integer | false | |||
| quantity | integer | false | |||
| shipDate | string | false | |||
| status | string | false | Order Status | ||
| complete | boolean | false |
| Property | Value |
| Name | Order |
| Technical name | Order |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| nullable | |
| Discriminator | |
| readOnly | |
| writeOnly | |
| xml | |
| name | |
| namespace | |
| prefix | |
| attribute | |
| wrapped | |
| extensions | |
| externalDocs | |
| example (deprecated) | |
| extensions | |
| Comments | |
| Property | Value |
| Name | id |
| Technical name | id |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | petId |
| Technical name | petId |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | quantity |
| Technical name | quantity |
| Activated | true |
| Id | |
| Type | integer |
| Format | int32 |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | shipDate |
| Technical name | shipDate |
| Activated | true |
| Id | |
| Type | string |
| Format | date-time |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | status |
| Technical name | status |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | Order Status |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | placed,approved,delivered |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | complete |
| Technical name | complete |
| Activated | true |
| Id | |
| Type | boolean |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | false |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| id | integer | false | |||
| name | string | false |
| Property | Value |
| Name | Category |
| Technical name | Category |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| nullable | |
| Discriminator | |
| readOnly | |
| writeOnly | |
| xml | |
| name | |
| namespace | |
| prefix | |
| attribute | |
| wrapped | |
| extensions | |
| externalDocs | |
| example (deprecated) | |
| extensions | |
| Comments | |
| Property | Value |
| Name | id |
| Technical name | id |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | name |
| Technical name | name |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| id | integer | false | |||
| username | string | false | |||
| firstName | string | false | |||
| lastName | string | false | |||
| string | false | ||||
| password | string | false | |||
| phone | string | false | |||
| userStatus | integer | false | User Status |
| Property | Value |
| Name | User |
| Technical name | User |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| nullable | |
| Discriminator | |
| readOnly | |
| writeOnly | |
| xml | |
| name | |
| namespace | |
| prefix | |
| attribute | |
| wrapped | |
| extensions | |
| externalDocs | |
| example (deprecated) | |
| extensions | |
| Comments | |
| Property | Value |
| Name | id |
| Technical name | id |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | username |
| Technical name | username |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | firstName |
| Technical name | firstName |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | lastName |
| Technical name | lastName |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | password |
| Technical name | password |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | phone |
| Technical name | phone |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | userStatus |
| Technical name | userStatus |
| Activated | true |
| Id | |
| Type | integer |
| Format | int32 |
| Title | |
| Description | User Status |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| id | integer | false | |||
| name | string | false |
| Property | Value |
| Name | Tag |
| Technical name | Tag |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| nullable | |
| Discriminator | |
| readOnly | |
| writeOnly | |
| xml | |
| name | |
| namespace | |
| prefix | |
| attribute | |
| wrapped | |
| extensions | |
| externalDocs | |
| example (deprecated) | |
| extensions | |
| Comments | |
| Property | Value |
| Name | id |
| Technical name | id |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | name |
| Technical name | name |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| id | integer | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| tags | array | false | |||
| status | string | false | pet status in the store |
| Property | Value |
| Name | Pet |
| Technical name | Pet |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| nullable | |
| Discriminator | |
| readOnly | |
| writeOnly | |
| xml | |
| name | |
| namespace | |
| prefix | |
| attribute | |
| wrapped | |
| extensions | |
| externalDocs | |
| example (deprecated) | |
| extensions | |
| Comments | |
| Property | Value |
| Name | id |
| Technical name | id |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | category |
| Technical name | category |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Reference description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | name |
| Technical name | name |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | true |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| [0] | string | false |
| Property | Value |
| Name | photoUrls |
| Technical name | photoUrls |
| Activated | true |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | true |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| name | |
| namespace | |
| prefix | |
| attribute | |
| wrapped | |
| extensions | |
| externalDocs | |
| collectionFormat | |
| example (deprecated) | |
| Comments | |
| Property | Value |
| Display name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| [0] | string | false |
| Property | Value |
| Name | tags |
| Technical name | tags |
| Activated | true |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| name | |
| namespace | |
| prefix | |
| attribute | |
| wrapped | |
| extensions | |
| externalDocs | |
| collectionFormat | |
| example (deprecated) | |
| Comments | |
| Property | Value |
| Display name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Reference description | |
| Primary key | false |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | status |
| Technical name | status |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | pet status in the store |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | available,pending,sold |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| code | integer | false | |||
| type | string | false | |||
| message | string | false |
| Property | Value |
| Name | ApiResponse |
| Technical name | ApiResponse |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| nullable | |
| Discriminator | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| example (deprecated) | |
| extensions | |
| Comments |
| Property | Value |
| Name | code |
| Technical name | code |
| Activated | true |
| Id | |
| Type | integer |
| Format | int32 |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | type |
| Technical name | type |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | message |
| Technical name | message |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Primary key | false |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| Foreign definition | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | responses |
| Technical name | |
| Type | componentObject |
| Property | Value |
| Name | parameters |
| Technical name | |
| Type | componentObject |
| Property | Value |
| Name | examples |
| Technical name | |
| Type | componentObject |
| Field | Type | Req | Key | Description | Comments |
| Pet | requestBody | true | Pet object that needs to be added to the store | ||
| UserArray | requestBody | true | List of user object |
| Property | Value |
| Name | requestBodies |
| Technical name | |
| Type | componentObject |
| Field | Type | Req | Key | Description | Comments |
| application/json | media | false | |||
| application/xml | media | false |
| Property | Value |
| Name | Pet |
| Technical name | Pet |
| Comments | |
| Type | requestBody |
| Required | true |
| Description | Pet object that needs to be added to the store |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | schema |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/xml |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | schema |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/json | media | false |
| Property | Value |
| Name | UserArray |
| Technical name | UserArray |
| Comments | |
| Type | requestBody |
| Required | true |
| Description | List of user object |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| schema | array | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| [0] | reference | false |
| Property | Value |
| Name | schema |
| Technical name | schema |
| Activated | true |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| collectionFormat | |
| example (deprecated) | |
| Comments |
| Property | Value |
| Name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | headers |
| Technical name | |
| Type | componentObject |
| Field | Type | Req | Key | Description | Comments |
| petstore_auth | securityScheme | false | |||
| api_key | securityScheme | false |
| Property | Value |
| Name | securitySchemes |
| Technical name | |
| Type | componentObject |
| Property | Value |
| Name | petstore_auth |
| Technical name | petstore_auth |
| Description | |
| Comments | |
| Subtype | oauth2 |
| flows | |
| implicit | |
| authorizationUrl | http://petstore.swagger.io/oauth/dialog |
| refreshUrl | |
| scopes | |
| [1] name | write:pets |
| description | modify pets in your account |
| [2] name | read:pets |
| description | read your pets |
| extensions | |
| password | |
| clientCredentials | |
| authorizationCode | |
| extensions | |
| extensions | |
| Property | Value |
| Name | api_key |
| Technical name | api_key |
| Description | |
| Comments | |
| Subtype | apiKey |
| apiKey name | api_key |
| in | header |
| extensions |
| Property | Value |
| Name | links |
| Technical name | |
| Type | componentObject |
| Field | Type | Req | Key | Description | Comments |
| myEvent | callback | false |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | componentObject |
| Property | Value |
| Name | myEvent |
| Technical name | |
| Callback expression | {$request.body#/callbackUrl}' |
| Resource | 59cd2390-9c25-11e9-8b46-f5ec5f7b4bd7 |
| Type | callback |
| Description | |
| Comments | |
| extensions |
| Property | Value |
| Name | Specification Extensions |
| extensions |
{
"openapi": "3.0.0",
"info": {
"title": "Swagger Petstore",
"description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"email": "apiteam@swagger.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0.0"
},
"servers": [
{
"url": "http://petstore.swagger.io/v2"
}
],
"paths": {
"/pets/findByStatus": {
"get": {
"tags": [
"pets"
],
"summary": "Finds Pets by status",
"description": "Multiple status values can be provided with comma separated strings",
"operationId": "findPetsByStatus",
"parameters": [
{
"name": "status",
"in": "query",
"description": "Status values that need to be considered for filter",
"required": true,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"available",
"pending",
"sold"
],
"default": "available"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pet"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pet"
}
}
}
}
},
"400": {
"description": "Invalid status value"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
},
"/pets/findByTags": {
"get": {
"tags": [
"pets"
],
"summary": "Finds Pets by tags",
"description": "Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
"operationId": "findPetsByTags",
"parameters": [
{
"name": "tags",
"in": "query",
"description": "Tags to filter by",
"required": true,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pet"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pet"
}
}
}
}
},
"400": {
"description": "Invalid tag value"
}
},
"deprecated": true,
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
},
"/pets/{petId}": {
"get": {
"tags": [
"pets"
],
"summary": "Find pet by ID",
"description": "Returns a single pet",
"operationId": "getPetById",
"parameters": [
{
"name": "petId",
"in": "path",
"description": "ID of pet to return",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pet"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Pet"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Pet not found"
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"pets"
],
"summary": "Updates a pet in the store with form data",
"operationId": "updatePetWithForm",
"parameters": [
{
"name": "petId",
"in": "path",
"description": "ID of pet that needs to be updated",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Updated name of the pet"
},
"status": {
"type": "string",
"description": "Updated status of the pet"
}
}
}
}
}
},
"responses": {
"405": {
"description": "Invalid input"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
},
"delete": {
"tags": [
"pets"
],
"summary": "Deletes a pet",
"operationId": "deletePet",
"parameters": [
{
"name": "api_key",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "petId",
"in": "path",
"description": "Pet id to delete",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Pet not found"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
},
"/pets/{petId}/uploadImage": {
"post": {
"tags": [
"pets"
],
"summary": "uploads an image",
"operationId": "uploadFile",
"parameters": [
{
"name": "petId",
"in": "path",
"description": "ID of pet to update",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
}
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
},
"/stores/inventory": {
"get": {
"tags": [
"stores"
],
"summary": "Returns pet inventories by status",
"description": "Returns a map of status codes to quantities",
"operationId": "getInventory",
"responses": {
"200": {
"description": "successful operation"
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stores/orders": {
"post": {
"tags": [
"stores"
],
"summary": "Place an order for a pet",
"operationId": "placeOrder",
"requestBody": {
"description": "order placed for purchasing the pet",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
}
}
},
"400": {
"description": "Invalid Order"
}
}
}
},
"/stores/orders/{orderId}": {
"get": {
"tags": [
"stores"
],
"summary": "Find purchase order by ID",
"description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
"operationId": "getOrderById",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "ID of pet that needs to be fetched",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 10
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Order not found"
}
}
},
"delete": {
"tags": [
"stores"
],
"summary": "Delete purchase order by ID",
"description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors",
"operationId": "deleteOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "ID of the order that needs to be deleted",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"minimum": 1
}
}
],
"responses": {
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Order not found"
}
}
}
},
"/users": {
"post": {
"tags": [
"users"
],
"summary": "Create user",
"description": "This can only be done by the logged in user.",
"operationId": "createUser",
"requestBody": {
"description": "Created user object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"responses": {
"default": {
"description": "successful operation"
}
}
}
},
"/users/createWithArray": {
"post": {
"tags": [
"users"
],
"summary": "Creates list of users with given input array",
"operationId": "createUsersWithArrayInput",
"requestBody": {
"$ref": "#/components/requestBodies/UserArray"
},
"responses": {
"default": {
"description": "successful operation"
}
}
}
},
"/users/createWithList": {
"post": {
"tags": [
"users"
],
"summary": "Creates list of users with given input array",
"operationId": "createUsersWithListInput",
"requestBody": {
"$ref": "#/components/requestBodies/UserArray"
},
"responses": {
"default": {
"description": "successful operation"
}
}
}
},
"/users/login": {
"get": {
"tags": [
"users"
],
"summary": "Logs user into the system",
"operationId": "loginUser",
"parameters": [
{
"name": "username",
"in": "query",
"description": "The user name for login",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "password",
"in": "query",
"description": "The password for login in clear text",
"required": true,
"schema": {
"type": "string",
"format": "password"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"headers": {
"X-Rate-Limit": {
"description": "calls per hour allowed by the user",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Expires-After": {
"description": "date in UTC when token expires",
"schema": {
"type": "string",
"format": "date-time"
}
}
},
"content": {
"application/xml": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Invalid username/password supplied"
}
}
}
},
"/users/logout": {
"get": {
"tags": [
"users"
],
"summary": "Logs out current logged in user session",
"operationId": "logoutUser",
"responses": {
"default": {
"description": "successful operation"
}
}
}
},
"/users/{username}": {
"get": {
"tags": [
"users"
],
"summary": "Get user by user name",
"operationId": "getUserByName",
"parameters": [
{
"name": "username",
"in": "path",
"description": "The name that needs to be fetched. Use user1 for testing. ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"400": {
"description": "Invalid username supplied"
},
"404": {
"description": "User not found"
}
}
},
"put": {
"tags": [
"users"
],
"summary": "Updated user",
"description": "This can only be done by the logged in user.",
"operationId": "updateUser",
"parameters": [
{
"name": "username",
"in": "path",
"description": "name that need to be updated",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Updated user object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Invalid user supplied"
},
"404": {
"description": "User not found"
}
}
},
"delete": {
"tags": [
"users"
],
"summary": "Delete user",
"description": "This can only be done by the logged in user.",
"operationId": "deleteUser",
"parameters": [
{
"name": "username",
"in": "path",
"description": "The name that needs to be deleted",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Invalid username supplied"
},
"404": {
"description": "User not found"
}
}
}
},
"/pets/{petId}(1)": {
"get": {
"tags": [
"pets"
],
"summary": "Find pet by ID",
"description": "Returns a single pet",
"operationId": "getPetById",
"parameters": [
{
"name": "petId",
"in": "path",
"description": "ID of pet to return",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Pet"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pet"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Pet not found"
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"pets"
],
"summary": "Updates a pet in the store with form data",
"operationId": "updatePetWithForm",
"parameters": [
{
"name": "petId",
"in": "path",
"description": "ID of pet that needs to be updated",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Updated name of the pet"
},
"status": {
"type": "string",
"description": "Updated status of the pet"
}
}
}
}
}
},
"responses": {
"405": {
"description": "Invalid input"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
},
"delete": {
"tags": [
"pets"
],
"summary": "Deletes a pet",
"operationId": "deletePet",
"parameters": [
{
"name": "api_key",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "petId",
"in": "path",
"description": "Pet id to delete",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Pet not found"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
}
},
"components": {
"schemas": {
"Order": {
"type": "object",
"title": "Order",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"title": "id"
},
"petId": {
"type": "integer",
"format": "int64",
"title": "petId"
},
"quantity": {
"type": "integer",
"format": "int32",
"title": "quantity"
},
"shipDate": {
"type": "string",
"format": "date-time",
"title": "shipDate"
},
"status": {
"type": "string",
"title": "status",
"description": "Order Status",
"enum": [
"placed",
"approved",
"delivered"
]
},
"complete": {
"type": "boolean",
"title": "complete",
"default": false
}
},
"xml": {}
},
"Category": {
"type": "object",
"title": "Category",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"title": "id"
},
"name": {
"type": "string",
"title": "name"
}
},
"xml": {}
},
"User": {
"type": "object",
"title": "User",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"title": "id"
},
"username": {
"type": "string",
"title": "username"
},
"firstName": {
"type": "string",
"title": "firstName"
},
"lastName": {
"type": "string",
"title": "lastName"
},
"email": {
"type": "string",
"title": "email"
},
"password": {
"type": "string",
"title": "password"
},
"phone": {
"type": "string",
"title": "phone"
},
"userStatus": {
"type": "integer",
"format": "int32",
"title": "userStatus",
"description": "User Status"
}
},
"xml": {}
},
"Tag": {
"type": "object",
"title": "Tag",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"title": "id"
},
"name": {
"type": "string",
"title": "name"
}
},
"xml": {}
},
"Pet": {
"type": "object",
"title": "Pet",
"required": [
"name",
"photoUrls"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"title": "id"
},
"category": {
"$ref": "#/components/schemas/Category"
},
"name": {
"type": "string",
"title": "name"
},
"photoUrls": {
"type": "array",
"title": "photoUrls",
"items": {
"type": "string"
},
"xml": {}
},
"tags": {
"type": "array",
"title": "tags",
"items": {
"$ref": "#/components/schemas/Tag"
},
"xml": {}
},
"status": {
"type": "string",
"title": "status",
"description": "pet status in the store",
"enum": [
"available",
"pending",
"sold"
]
}
},
"xml": {}
},
"ApiResponse": {
"type": "object",
"title": "ApiResponse",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"title": "code"
},
"type": {
"type": "string",
"title": "type"
},
"message": {
"type": "string",
"title": "message"
}
}
}
},
"requestBodies": {
"Pet": {
"description": "Pet object that needs to be added to the store",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pet"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Pet"
}
}
},
"required": true
},
"UserArray": {
"description": "List of user object",
"content": {
"application/json": {
"schema": {
"type": "array",
"title": "schema",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
},
"required": true
}
},
"securitySchemes": {
"petstore_auth": {
"flows": {
"implicit": {
"authorizationUrl": "http://petstore.swagger.io/oauth/dialog",
"scopes": {
"write:pets": "modify pets in your account",
"read:pets": "read your pets"
}
}
},
"type": "oauth2"
},
"api_key": {
"name": "api_key",
"in": "header",
"type": "apiKey"
}
},
"callbacks": {
"myEvent": {
"{$request.body#/callbackUrl}'": {
"post": {
"tags": [
"pets"
],
"summary": "Add a new pet to the store",
"operationId": "addPet",
"requestBody": {
"$ref": "#model/definitions/requestBodies/Pet"
},
"responses": {
"405": {
"description": "Invalid input"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
},
"put": {
"tags": [
"pets"
],
"summary": "Update an existing pet",
"operationId": "updatePet",
"requestBody": {
"$ref": "#model/definitions/requestBodies/Pet"
},
"responses": {
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Pet not found"
},
"405": {
"description": "Validation exception"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
}
}
}
},
"tags": [
{
"name": "pets",
"description": "Everything about your Pets"
},
{
"name": "stores",
"description": "Find out more"
},
{
"name": "users",
"description": "More about users"
}
],
"externalDocs": {
"description": "Find out more about Swagger",
"url": "http://swagger.io"
},
"x-origin": {
"url": "http://petstore.swagger.io/v2/swagger.json",
"format": "swagger",
"version": "2.0",
"converter": {
"url": "https://github.com/mermade/swagger2openapi",
"version": "2.2.0"
}
}
}
| Property | Value |
| Resource path | /pets |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | post |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /pets |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Add a new pet to the store |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | addPet |
| deprecated | |
| security | |
| [1] pattern {name} | petstore_auth |
| operation | write:petsread:pets |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| requestBody | requestBody | false | Pet object that needs to be added to the store | ||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| application/xml | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "post",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true
},
"requestBody": {
"$ref": "#model/definitions/requestBodies/properties/Pet"
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [],
"requestBody": {
"application/json": {
"schema": {
"id": -26,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
},
"examples": {},
"encoding": {}
},
"application/xml": {
"schema": {
"id": -60,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
},
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | 405 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid input |
| Resources | /pets |
| Parent request | post |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid input | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid input |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "405",
"description": "Invalid input",
"properties": {
"response": {
"type": "object",
"description": "Invalid input",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Request operation | put |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /pets |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Update an existing pet |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | updatePet |
| deprecated | |
| security | |
| [1] pattern {name} | petstore_auth |
| operation | write:petsread:pets |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| requestBody | requestBody | false | Pet object that needs to be added to the store | ||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| application/xml | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "put",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true
},
"requestBody": {
"$ref": "#model/definitions/requestBodies/properties/Pet"
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [],
"requestBody": {
"application/json": {
"schema": {
"id": -53,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
},
"examples": {},
"encoding": {}
},
"application/xml": {
"schema": {
"id": 8,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
},
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid ID supplied |
| Resources | /pets |
| Parent request | put |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid ID supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid ID supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid ID supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid ID supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | Pet not found |
| Resources | /pets |
| Parent request | put |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Pet not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Pet not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "Pet not found",
"properties": {
"response": {
"type": "object",
"description": "Pet not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 405 |
| Activated | true |
| Id | |
| $ref | |
| Description | Validation exception |
| Resources | /pets |
| Parent request | put |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Validation exception | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Validation exception |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "405",
"description": "Validation exception",
"properties": {
"response": {
"type": "object",
"description": "Validation exception",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /pets/findByStatus |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | get |
| Activated | true |
| Id | |
| $ref | |
| Description | Multiple status values can be provided with comma separated strings |
| Resources | /pets/findByStatus |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Finds Pets by status |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | findPetsByStatus |
| deprecated | |
| security | |
| [1] pattern {name} | petstore_auth |
| operation | write:petsread:pets |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] status | parameter (query) | true | Status values that need to be considered for filter | ||
| schema | array | false | |||
| [0] | string | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] status | parameter (query) | true | Status values that need to be considered for filter |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | array | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | status |
| Activated | true |
| Parameter name | status |
| Type | parameter (query) |
| Description | Status values that need to be considered for filter |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | true |
| Allow Reserved | |
| example | |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| [0] | string | false |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| collectionFormat | |
| example (deprecated) | |
| Comments |
| Property | Value |
| Display name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Deprecated | |
| Default | available |
| Min length | |
| Max length | |
| Pattern | |
| Enum | available,pending,sold |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "get",
"description": "Multiple status values can be provided with comma separated strings",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "Status values that need to be considered for filter",
"properties": {
"schema": {
"type": "array",
"additionalItems": true,
"items": {
"type": "string",
"default": "available",
"enum": [
"available",
"pending",
"sold"
]
}
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": [
"available"
],
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /pets/findByStatus |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| application/xml | media | false | |||
| schema | array | false | |||
| [0] | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| application/json | media | false | |||
| schema | array | false | |||
| [0] | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/xml | media | false | |||
| application/json | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | array | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/xml |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| [0] | reference | false |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| collectionFormat | |
| example (deprecated) | |
| Comments |
| Property | Value |
| Name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | array | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| [0] | reference | false |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| collectionFormat | |
| example (deprecated) | |
| Comments |
| Property | Value |
| Name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/xml": {
"type": "object",
"properties": {
"schema": {
"type": "array",
"additionalItems": true,
"items": {
"$ref": "#model/definitions/schemas/properties/Pet"
}
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
},
"application/json": {
"type": "object",
"properties": {
"schema": {
"type": "array",
"additionalItems": true,
"items": {
"$ref": "#model/definitions/schemas/properties/Pet"
}
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {
"application/xml": {
"schema": [
{
"id": 76,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
}
],
"examples": {},
"encoding": {}
},
"application/json": {
"schema": [
{
"id": 49,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
}
],
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid status value |
| Resources | /pets/findByStatus |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid status value | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid status value |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid status value",
"properties": {
"response": {
"type": "object",
"description": "Invalid status value",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /pets/findByTags |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | get |
| Activated | true |
| Id | |
| $ref | |
| Description | Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. |
| Resources | /pets/findByTags |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Finds Pets by tags |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | findPetsByTags |
| deprecated | true |
| security | |
| [1] pattern {name} | petstore_auth |
| operation | write:petsread:pets |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] tags | parameter (query) | true | Tags to filter by | ||
| schema | array | false | |||
| [0] | string | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] tags | parameter (query) | true | Tags to filter by |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | array | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | tags |
| Activated | true |
| Parameter name | tags |
| Type | parameter (query) |
| Description | Tags to filter by |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | true |
| Allow Reserved | |
| example | |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| [0] | string | false |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| collectionFormat | |
| example (deprecated) | |
| Comments |
| Property | Value |
| Display name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "get",
"description": "Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "Tags to filter by",
"properties": {
"schema": {
"type": "array",
"additionalItems": true,
"items": {
"type": "string"
}
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": [
"Lorem"
],
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /pets/findByTags |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| application/xml | media | false | |||
| schema | array | false | |||
| [0] | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| application/json | media | false | |||
| schema | array | false | |||
| [0] | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/xml | media | false | |||
| application/json | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | array | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/xml |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| [0] | reference | false |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| collectionFormat | |
| example (deprecated) | |
| Comments |
| Property | Value |
| Name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | array | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| [0] | reference | false |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| collectionFormat | |
| example (deprecated) | |
| Comments |
| Property | Value |
| Name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/xml": {
"type": "object",
"properties": {
"schema": {
"type": "array",
"additionalItems": true,
"items": {
"$ref": "#model/definitions/schemas/properties/Pet"
}
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
},
"application/json": {
"type": "object",
"properties": {
"schema": {
"type": "array",
"additionalItems": true,
"items": {
"$ref": "#model/definitions/schemas/properties/Pet"
}
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {
"application/xml": {
"schema": [
{
"id": -100,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
}
],
"examples": {},
"encoding": {}
},
"application/json": {
"schema": [
{
"id": 31,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
}
],
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid tag value |
| Resources | /pets/findByTags |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid tag value | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid tag value |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid tag value",
"properties": {
"response": {
"type": "object",
"description": "Invalid tag value",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /pets/{petId} |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | delete |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /pets/{petId} |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Deletes a pet |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | deletePet |
| deprecated | |
| security | |
| [1] pattern {name} | petstore_auth |
| operation | write:petsread:pets |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] api_key | parameter (header) | false | |||
| schema | string | false | |||
| content | object | false | |||
| examples | object | false | |||
| [1] petId | parameter (path) | true | Pet id to delete | ||
| schema | int64 | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] api_key | parameter (header) | false | |||
| [1] petId | parameter (path) | true | Pet id to delete |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | api_key |
| Activated | true |
| Parameter name | api_key |
| Type | parameter (header) |
| Description | |
| Comments | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | petId |
| Activated | true |
| Parameter name | petId |
| Type | parameter (path) |
| Description | Pet id to delete |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "delete",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": [
{
"type": "object",
"properties": {
"schema": {
"type": "string"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Pet id to delete",
"properties": {
"schema": {
"type": "number"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": "Lorem",
"content": {},
"examples": {}
},
{
"schema": -21,
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid ID supplied |
| Resources | /pets/{petId} |
| Parent request | delete |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid ID supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid ID supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid ID supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid ID supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | Pet not found |
| Resources | /pets/{petId} |
| Parent request | delete |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Pet not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Pet not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "Pet not found",
"properties": {
"response": {
"type": "object",
"description": "Pet not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Request operation | get |
| Activated | true |
| Id | |
| $ref | |
| Description | Returns a single pet |
| Resources | /pets/{petId} |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Find pet by ID |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | getPetById |
| deprecated | |
| security | |
| [1] pattern {name} | api_key |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] petId | parameter (path) | true | ID of pet to return | ||
| schema | int64 | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] petId | parameter (path) | true | ID of pet to return |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | petId |
| Activated | true |
| Parameter name | petId |
| Type | parameter (path) |
| Description | ID of pet to return |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "get",
"description": "Returns a single pet",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "ID of pet to return",
"properties": {
"schema": {
"type": "number"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": 39,
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /pets/{petId} |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| application/xml | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/json | media | false | |||
| application/xml | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/xml |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/json": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/Pet"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
},
"application/xml": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/Pet"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {
"application/json": {
"schema": {
"id": 9,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
},
"examples": {},
"encoding": {}
},
"application/xml": {
"schema": {
"id": 95,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
},
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid ID supplied |
| Resources | /pets/{petId} |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid ID supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid ID supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid ID supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid ID supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | Pet not found |
| Resources | /pets/{petId} |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Pet not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Pet not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "Pet not found",
"properties": {
"response": {
"type": "object",
"description": "Pet not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Request operation | post |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /pets/{petId} |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Updates a pet in the store with form data |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | updatePetWithForm |
| deprecated | |
| security | |
| [1] pattern {name} | petstore_auth |
| operation | write:petsread:pets |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] petId | parameter (path) | true | ID of pet that needs to be updated | ||
| schema | int64 | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| application/x-www-form-urlencoded | media | false | |||
| schema | object | false | |||
| name | string | false | Updated name of the pet | ||
| status | string | false | Updated status of the pet | ||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] petId | parameter (path) | true | ID of pet that needs to be updated |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | petId |
| Activated | true |
| Parameter name | petId |
| Type | parameter (path) |
| Description | ID of pet that needs to be updated |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/x-www-form-urlencoded | media | false |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| schema | object | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/x-www-form-urlencoded |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| name | string | false | Updated name of the pet | ||
| status | string | false | Updated status of the pet |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| nullable | |
| Discriminator | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| example (deprecated) | |
| extensions | |
| Comments |
| Property | Value |
| Name | name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | Updated name of the pet |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | status |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | Updated status of the pet |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "post",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "ID of pet that needs to be updated",
"properties": {
"schema": {
"type": "number"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"properties": {
"application/x-www-form-urlencoded": {
"type": "object",
"properties": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Updated name of the pet"
},
"status": {
"type": "string",
"description": "Updated status of the pet"
}
},
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": 18,
"content": {},
"examples": {}
}
],
"requestBody": {
"application/x-www-form-urlencoded": {
"schema": {
"name": "Lorem",
"status": "Lorem"
},
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | 405 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid input |
| Resources | /pets/{petId} |
| Parent request | post |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid input | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid input |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "405",
"description": "Invalid input",
"properties": {
"response": {
"type": "object",
"description": "Invalid input",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /pets/{petId}(1) |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | delete |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /pets/{petId}(1) |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Deletes a pet |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | deletePet |
| deprecated | |
| security | |
| [1] pattern {name} | petstore_auth |
| operation | write:petsread:pets |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] api_key | parameter (header) | false | |||
| schema | string | false | |||
| content | object | false | |||
| examples | object | false | |||
| [1] petId | parameter (path) | true | Pet id to delete | ||
| schema | int64 | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] api_key | parameter (header) | false | |||
| [1] petId | parameter (path) | true | Pet id to delete |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | api_key |
| Activated | true |
| Parameter name | api_key |
| Type | parameter (header) |
| Description | |
| Comments | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | petId |
| Activated | true |
| Parameter name | petId |
| Type | parameter (path) |
| Description | Pet id to delete |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "delete",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": [
{
"type": "object",
"properties": {
"schema": {
"type": "string"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Pet id to delete",
"properties": {
"schema": {
"type": "number"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": "Lorem",
"content": {},
"examples": {}
},
{
"schema": 91,
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid ID supplied |
| Resources | /pets/{petId}(1) |
| Parent request | delete |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid ID supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid ID supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid ID supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid ID supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | Pet not found |
| Resources | /pets/{petId}(1) |
| Parent request | delete |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Pet not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Pet not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "Pet not found",
"properties": {
"response": {
"type": "object",
"description": "Pet not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Request operation | get |
| Activated | true |
| Id | |
| $ref | |
| Description | Returns a single pet |
| Resources | /pets/{petId}(1) |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Find pet by ID |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | getPetById |
| deprecated | |
| security | |
| [1] pattern {name} | api_key |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] petId | parameter (path) | true | ID of pet to return | ||
| schema | int64 | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] petId | parameter (path) | true | ID of pet to return |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | petId |
| Activated | true |
| Parameter name | petId |
| Type | parameter (path) |
| Description | ID of pet to return |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "get",
"description": "Returns a single pet",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "ID of pet to return",
"properties": {
"schema": {
"type": "number"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": 31,
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /pets/{petId}(1) |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| application/xml | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| category | string | false | |||
| name | string | true | |||
| photoUrls | array | true | |||
| [0] | string | false | |||
| tags | array | false | |||
| [0] | string | false | |||
| status | string | false | pet status in the store | ||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/xml | media | false | |||
| application/json | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/xml |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/xml": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/Pet"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
},
"application/json": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/Pet"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {
"application/xml": {
"schema": {
"id": -85,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
},
"examples": {},
"encoding": {}
},
"application/json": {
"schema": {
"id": 87,
"category": "Lorem",
"name": "Lorem",
"photoUrls": [
"Lorem"
],
"tags": [
"Lorem"
],
"status": "sold"
},
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid ID supplied |
| Resources | /pets/{petId}(1) |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid ID supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid ID supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid ID supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid ID supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | Pet not found |
| Resources | /pets/{petId}(1) |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Pet not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Pet not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "Pet not found",
"properties": {
"response": {
"type": "object",
"description": "Pet not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Request operation | post |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /pets/{petId}(1) |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | Updates a pet in the store with form data |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | updatePetWithForm |
| deprecated | |
| security | |
| [1] pattern {name} | petstore_auth |
| operation | write:petsread:pets |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] petId | parameter (path) | true | ID of pet that needs to be updated | ||
| schema | int64 | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| application/x-www-form-urlencoded | media | false | |||
| schema | object | false | |||
| name | string | false | Updated name of the pet | ||
| status | string | false | Updated status of the pet | ||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] petId | parameter (path) | true | ID of pet that needs to be updated |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | petId |
| Activated | true |
| Parameter name | petId |
| Type | parameter (path) |
| Description | ID of pet that needs to be updated |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/x-www-form-urlencoded | media | false |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| schema | object | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/x-www-form-urlencoded |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| name | string | false | Updated name of the pet | ||
| status | string | false | Updated status of the pet |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| nullable | |
| Discriminator | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| example (deprecated) | |
| extensions | |
| Comments |
| Property | Value |
| Name | name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | Updated name of the pet |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | status |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | Updated status of the pet |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "post",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "ID of pet that needs to be updated",
"properties": {
"schema": {
"type": "number"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"properties": {
"application/x-www-form-urlencoded": {
"type": "object",
"properties": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Updated name of the pet"
},
"status": {
"type": "string",
"description": "Updated status of the pet"
}
},
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": -46,
"content": {},
"examples": {}
}
],
"requestBody": {
"application/x-www-form-urlencoded": {
"schema": {
"name": "Lorem",
"status": "Lorem"
},
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | 405 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid input |
| Resources | /pets/{petId}(1) |
| Parent request | post |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid input | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid input |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "405",
"description": "Invalid input",
"properties": {
"response": {
"type": "object",
"description": "Invalid input",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /pets/{petId}/uploadImage |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | post |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /pets/{petId}/uploadImage |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | pets |
| summary | uploads an image |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | uploadFile |
| deprecated | |
| security | |
| [1] pattern {name} | petstore_auth |
| operation | write:petsread:pets |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] petId | parameter (path) | true | ID of pet to update | ||
| schema | int64 | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| application/octet-stream | media | false | |||
| schema | binary | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] petId | parameter (path) | true | ID of pet to update |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | petId |
| Activated | true |
| Parameter name | petId |
| Type | parameter (path) |
| Description | ID of pet to update |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/octet-stream | media | false |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/octet-stream |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | binary |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "post",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "ID of pet to update",
"properties": {
"schema": {
"type": "number"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"properties": {
"application/octet-stream": {
"type": "object",
"properties": {
"schema": {
"type": "string",
"format": "binary"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": 85,
"content": {},
"examples": {}
}
],
"requestBody": {
"application/octet-stream": {
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /pets/{petId}/uploadImage |
| Parent request | post |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| application/json | media | false | |||
| schema | object | false | |||
| code | int32 | false | |||
| type | string | false | |||
| message | string | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/json | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/json": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/ApiResponse"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {
"application/json": {
"schema": {
"code": -15,
"type": "Lorem",
"message": "Lorem"
},
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Resource path | /stores/inventory |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | get |
| Activated | true |
| Id | |
| $ref | |
| Description | Returns a map of status codes to quantities |
| Resources | /stores/inventory |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | stores |
| summary | Returns pet inventories by status |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | getInventory |
| deprecated | |
| security | |
| [1] pattern {name} | api_key |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "get",
"description": "Returns a map of status codes to quantities",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /stores/inventory |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| application/json | media | false | |||
| schema | object | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/json | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | object | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Object |
| AdditionalProp Type | integer |
| AdditionalProp Format | int32 |
| nullable | |
| Discriminator | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| example (deprecated) | |
| extensions | |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/json": {
"type": "object",
"properties": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
}
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {
"application/json": {
"schema": {},
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Resource path | /stores/orders |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | post |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /stores/orders |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | stores |
| summary | Place an order for a pet |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | placeOrder |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| requestBody | requestBody | true | order placed for purchasing the pet | ||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| petId | int64 | false | |||
| quantity | int32 | false | |||
| shipDate | date-time | false | |||
| status | string | false | Order Status | ||
| complete | boolean | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/json | media | false |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | true |
| Description | order placed for purchasing the pet |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "post",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true
},
"requestBody": {
"type": "object",
"description": "order placed for purchasing the pet",
"properties": {
"application/json": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/Order"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true,
"required": [
"requestBody"
]
}{
"parameters": [],
"requestBody": {
"application/json": {
"schema": {
"id": 18,
"petId": 26,
"quantity": 72,
"shipDate": "2011-06-14T04:12:36.123Z",
"status": "delivered",
"complete": false
},
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /stores/orders |
| Parent request | post |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| application/xml | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| petId | int64 | false | |||
| quantity | int32 | false | |||
| shipDate | date-time | false | |||
| status | string | false | Order Status | ||
| complete | boolean | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| petId | int64 | false | |||
| quantity | int32 | false | |||
| shipDate | date-time | false | |||
| status | string | false | Order Status | ||
| complete | boolean | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/xml | media | false | |||
| application/json | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/xml |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/xml": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/Order"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
},
"application/json": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/Order"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {
"application/xml": {
"schema": {
"id": 73,
"petId": 77,
"quantity": 59,
"shipDate": "2011-06-14T04:12:36.123Z",
"status": "delivered",
"complete": false
},
"examples": {},
"encoding": {}
},
"application/json": {
"schema": {
"id": 16,
"petId": -73,
"quantity": -83,
"shipDate": "2011-06-14T04:12:36.123Z",
"status": "delivered",
"complete": false
},
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid Order |
| Resources | /stores/orders |
| Parent request | post |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid Order | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid Order |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid Order",
"properties": {
"response": {
"type": "object",
"description": "Invalid Order",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /stores/orders/{orderId} |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | delete |
| Activated | true |
| Id | |
| $ref | |
| Description | For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors |
| Resources | /stores/orders/{orderId} |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | stores |
| summary | Delete purchase order by ID |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | deleteOrder |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] orderId | parameter (path) | true | ID of the order that needs to be deleted | ||
| schema | int64 | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] orderId | parameter (path) | true | ID of the order that needs to be deleted |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | orderId |
| Activated | true |
| Parameter name | orderId |
| Type | parameter (path) |
| Description | ID of the order that needs to be deleted |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | 1 |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "delete",
"description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "ID of the order that needs to be deleted",
"properties": {
"schema": {
"type": "number",
"minimum": 1
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": 45,
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid ID supplied |
| Resources | /stores/orders/{orderId} |
| Parent request | delete |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid ID supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid ID supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid ID supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid ID supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | Order not found |
| Resources | /stores/orders/{orderId} |
| Parent request | delete |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Order not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Order not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "Order not found",
"properties": {
"response": {
"type": "object",
"description": "Order not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Request operation | get |
| Activated | true |
| Id | |
| $ref | |
| Description | For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions |
| Resources | /stores/orders/{orderId} |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | stores |
| summary | Find purchase order by ID |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | getOrderById |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] orderId | parameter (path) | true | ID of pet that needs to be fetched | ||
| schema | int64 | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] orderId | parameter (path) | true | ID of pet that needs to be fetched |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | orderId |
| Activated | true |
| Parameter name | orderId |
| Type | parameter (path) |
| Description | ID of pet that needs to be fetched |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int64 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | 1 |
| Excl min | |
| Max value | 10 |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "get",
"description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "ID of pet that needs to be fetched",
"properties": {
"schema": {
"type": "number",
"maximum": 10,
"minimum": 1
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": 7,
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /stores/orders/{orderId} |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| application/xml | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| petId | int64 | false | |||
| quantity | int32 | false | |||
| shipDate | date-time | false | |||
| status | string | false | Order Status | ||
| complete | boolean | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| petId | int64 | false | |||
| quantity | int32 | false | |||
| shipDate | date-time | false | |||
| status | string | false | Order Status | ||
| complete | boolean | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/xml | media | false | |||
| application/json | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/xml |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/xml": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/Order"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
},
"application/json": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/Order"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {
"application/xml": {
"schema": {
"id": -88,
"petId": 36,
"quantity": 28,
"shipDate": "2011-06-14T04:12:36.123Z",
"status": "delivered",
"complete": false
},
"examples": {},
"encoding": {}
},
"application/json": {
"schema": {
"id": -55,
"petId": -29,
"quantity": -82,
"shipDate": "2011-06-14T04:12:36.123Z",
"status": "delivered",
"complete": false
},
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid ID supplied |
| Resources | /stores/orders/{orderId} |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid ID supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid ID supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid ID supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid ID supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | Order not found |
| Resources | /stores/orders/{orderId} |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Order not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Order not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "Order not found",
"properties": {
"response": {
"type": "object",
"description": "Order not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /users |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | post |
| Activated | true |
| Id | |
| $ref | |
| Description | This can only be done by the logged in user. |
| Resources | /users |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | users |
| summary | Create user |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | createUser |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| requestBody | requestBody | true | Created user object | ||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| username | string | false | |||
| firstName | string | false | |||
| lastName | string | false | |||
| string | false | ||||
| password | string | false | |||
| phone | string | false | |||
| userStatus | int32 | false | User Status | ||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/json | media | false |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | true |
| Description | Created user object |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "post",
"description": "This can only be done by the logged in user.",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true
},
"requestBody": {
"type": "object",
"description": "Created user object",
"properties": {
"application/json": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/User"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true,
"required": [
"requestBody"
]
}{
"parameters": [],
"requestBody": {
"application/json": {
"schema": {
"id": 64,
"username": "Lorem",
"firstName": "Lorem",
"lastName": "Lorem",
"email": "Lorem",
"password": "Lorem",
"phone": "Lorem",
"userStatus": 61
},
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | default |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /users |
| Parent request | post |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "default",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /users/createWithArray |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | post |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /users/createWithArray |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | users |
| summary | Creates list of users with given input array |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | createUsersWithArrayInput |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| requestBody | requestBody | false | List of user object | ||
| application/json | media | false | |||
| schema | array | false | |||
| [0] | object | false | |||
| id | int64 | false | |||
| username | string | false | |||
| firstName | string | false | |||
| lastName | string | false | |||
| string | false | ||||
| password | string | false | |||
| phone | string | false | |||
| userStatus | int32 | false | User Status | ||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "post",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true
},
"requestBody": {
"$ref": "#model/definitions/requestBodies/properties/UserArray"
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [],
"requestBody": {
"application/json": {
"schema": [
{
"id": -39,
"username": "Lorem",
"firstName": "Lorem",
"lastName": "Lorem",
"email": "Lorem",
"password": "Lorem",
"phone": "Lorem",
"userStatus": -24
}
],
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | default |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /users/createWithArray |
| Parent request | post |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "default",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /users/createWithList |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | post |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /users/createWithList |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | users |
| summary | Creates list of users with given input array |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | createUsersWithListInput |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| requestBody | requestBody | false | List of user object | ||
| application/json | media | false | |||
| schema | array | false | |||
| [0] | object | false | |||
| id | int64 | false | |||
| username | string | false | |||
| firstName | string | false | |||
| lastName | string | false | |||
| string | false | ||||
| password | string | false | |||
| phone | string | false | |||
| userStatus | int32 | false | User Status | ||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "post",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true
},
"requestBody": {
"$ref": "#model/definitions/requestBodies/properties/UserArray"
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [],
"requestBody": {
"application/json": {
"schema": [
{
"id": -76,
"username": "Lorem",
"firstName": "Lorem",
"lastName": "Lorem",
"email": "Lorem",
"password": "Lorem",
"phone": "Lorem",
"userStatus": -77
}
],
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | default |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /users/createWithList |
| Parent request | post |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "default",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /users/login |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | get |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /users/login |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | users |
| summary | Logs user into the system |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | loginUser |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] username | parameter (query) | true | The user name for login | ||
| schema | string | false | |||
| content | object | false | |||
| examples | object | false | |||
| [1] password | parameter (query) | true | The password for login in clear text | ||
| schema | password | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] username | parameter (query) | true | The user name for login | ||
| [1] password | parameter (query) | true | The password for login in clear text |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | username |
| Activated | true |
| Parameter name | username |
| Type | parameter (query) |
| Description | The user name for login |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | password |
| Activated | true |
| Parameter name | password |
| Type | parameter (query) |
| Description | The password for login in clear text |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | password |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "get",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": [
{
"type": "object",
"description": "The user name for login",
"properties": {
"schema": {
"type": "string"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "The password for login in clear text",
"properties": {
"schema": {
"type": "string",
"format": "password"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": "Lorem",
"content": {},
"examples": {}
},
{
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /users/login |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| X-Rate-Limit | header | false | calls per hour allowed by the user | ||
| schema | int32 | false | |||
| content | object | false | |||
| examples | object | false | |||
| X-Expires-After | header | false | date in UTC when token expires | ||
| schema | date-time | false | |||
| content | object | false | |||
| examples | object | false | |||
| content | object | false | |||
| application/xml | media | false | |||
| schema | string | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| application/json | media | false | |||
| schema | string | false | |||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| X-Rate-Limit | header | false | calls per hour allowed by the user | ||
| X-Expires-After | header | false | date in UTC when token expires |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | integer | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Name | X-Rate-Limit |
| Technical name | |
| Activated | true |
| Type | header |
| Description | calls per hour allowed by the user |
| Comments | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | integer |
| Format | int32 |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Name | X-Expires-After |
| Technical name | |
| Activated | true |
| Type | header |
| Description | date in UTC when token expires |
| Comments | |
| Required | |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | date-time |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/xml | media | false | |||
| application/json | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/xml |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"properties": {
"X-Rate-Limit": {
"type": "object",
"description": "calls per hour allowed by the user",
"properties": {
"schema": {
"type": "number"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
},
"X-Expires-After": {
"type": "object",
"description": "date in UTC when token expires",
"properties": {
"schema": {
"type": "string",
"format": "date-time"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/xml": {
"type": "object",
"properties": {
"schema": {
"type": "string"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
},
"application/json": {
"type": "object",
"properties": {
"schema": {
"type": "string"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {
"X-Rate-Limit": {
"schema": -43,
"content": {},
"examples": {}
},
"X-Expires-After": {
"schema": "2011-06-14T04:12:36.123Z",
"content": {},
"examples": {}
}
},
"content": {
"application/xml": {
"schema": "Lorem",
"examples": {},
"encoding": {}
},
"application/json": {
"schema": "Lorem",
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid username/password supplied |
| Resources | /users/login |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid username/password supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid username/password supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid username/password supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid username/password supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /users/logout |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | get |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /users/logout |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | users |
| summary | Logs out current logged in user session |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | logoutUser |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "get",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | default |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /users/logout |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "default",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Resource path | /users/{username} |
| Activated | true |
| Description | |
| summary | |
| extensions | |
| [1] pattern | |
| value | |
| Comments | |
| Property | Value |
| Request operation | delete |
| Activated | true |
| Id | |
| $ref | |
| Description | This can only be done by the logged in user. |
| Resources | /users/{username} |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | users |
| summary | Delete user |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | deleteUser |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] username | parameter (path) | true | The name that needs to be deleted | ||
| schema | string | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] username | parameter (path) | true | The name that needs to be deleted |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | username |
| Activated | true |
| Parameter name | username |
| Type | parameter (path) |
| Description | The name that needs to be deleted |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "delete",
"description": "This can only be done by the logged in user.",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "The name that needs to be deleted",
"properties": {
"schema": {
"type": "string"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": "Lorem",
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid username supplied |
| Resources | /users/{username} |
| Parent request | delete |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid username supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid username supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid username supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid username supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | User not found |
| Resources | /users/{username} |
| Parent request | delete |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | User not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | User not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "User not found",
"properties": {
"response": {
"type": "object",
"description": "User not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Request operation | get |
| Activated | true |
| Id | |
| $ref | |
| Description | |
| Resources | /users/{username} |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | users |
| summary | Get user by user name |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | getUserByName |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] username | parameter (path) | true | The name that needs to be fetched. Use user1 for testing. | ||
| schema | string | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] username | parameter (path) | true | The name that needs to be fetched. Use user1 for testing. |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | username |
| Activated | true |
| Parameter name | username |
| Type | parameter (path) |
| Description | The name that needs to be fetched. Use user1 for testing. |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | |
| Description | |
| extensions |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "get",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "The name that needs to be fetched. Use user1 for testing. ",
"properties": {
"schema": {
"type": "string"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true
}{
"parameters": [
{
"schema": "Lorem",
"content": {},
"examples": {}
}
],
"requestBody": {},
"callbacks": {}
}| Property | Value |
| Response | 200 |
| Activated | true |
| Id | |
| $ref | |
| Description | successful operation |
| Resources | /users/{username} |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | successful operation | ||
| headers | object | false | |||
| content | object | false | |||
| application/xml | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| username | string | false | |||
| firstName | string | false | |||
| lastName | string | false | |||
| string | false | ||||
| password | string | false | |||
| phone | string | false | |||
| userStatus | int32 | false | User Status | ||
| examples | object | false | |||
| encoding | object | false | |||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| username | string | false | |||
| firstName | string | false | |||
| lastName | string | false | |||
| string | false | ||||
| password | string | false | |||
| phone | string | false | |||
| userStatus | int32 | false | User Status | ||
| examples | object | false | |||
| encoding | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | successful operation |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/xml | media | false | |||
| application/json | media | false |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/xml |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "200",
"description": "successful operation",
"properties": {
"response": {
"type": "object",
"description": "successful operation",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"properties": {
"application/xml": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/User"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
},
"application/json": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/User"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {
"application/xml": {
"schema": {
"id": 42,
"username": "Lorem",
"firstName": "Lorem",
"lastName": "Lorem",
"email": "Lorem",
"password": "Lorem",
"phone": "Lorem",
"userStatus": -23
},
"examples": {},
"encoding": {}
},
"application/json": {
"schema": {
"id": -37,
"username": "Lorem",
"firstName": "Lorem",
"lastName": "Lorem",
"email": "Lorem",
"password": "Lorem",
"phone": "Lorem",
"userStatus": 62
},
"examples": {},
"encoding": {}
}
},
"links": {}
}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid username supplied |
| Resources | /users/{username} |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid username supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid username supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid username supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid username supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | User not found |
| Resources | /users/{username} |
| Parent request | get |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | User not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | User not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "User not found",
"properties": {
"response": {
"type": "object",
"description": "User not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Request operation | put |
| Activated | true |
| Id | |
| $ref | |
| Description | This can only be done by the logged in user. |
| Resources | /users/{username} |
| Parent request | |
| Child response | |
| Comments | |
| tags | |
| [1] tag | users |
| summary | Updated user |
| externalDocs | |
| [1] url | |
| description | |
| extensions | |
| operationId | updateUser |
| deprecated | |
| security | |
| [1] pattern {name} | |
| operation | |
| servers | |
| [1] url | |
| description | |
| variables | |
| extensions | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| parameters | array | false | |||
| [0] username | parameter (path) | true | name that need to be updated | ||
| schema | string | false | |||
| content | object | false | |||
| examples | object | false | |||
| requestBody | requestBody | true | Updated user object | ||
| application/json | media | false | |||
| schema | object | false | |||
| id | int64 | false | |||
| username | string | false | |||
| firstName | string | false | |||
| lastName | string | false | |||
| string | false | ||||
| password | string | false | |||
| phone | string | false | |||
| userStatus | int32 | false | User Status | ||
| examples | object | false | |||
| encoding | object | false | |||
| callbacks | operationObject | false |
| Field | Type | Req | Key | Description | Comments |
| [0] username | parameter (path) | true | name that need to be updated |
| Property | Value |
| Name | parameters |
| Technical name | parameters |
| Id | |
| Type | array |
| Title | |
| Description | |
| Required | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| schema | string | false | |||
| content | object | false | |||
| examples | object | false |
| Property | Value |
| Display name | username |
| Activated | true |
| Parameter name | username |
| Type | parameter (path) |
| Description | name that need to be updated |
| Comments | |
| Required | true |
| Deprecated | |
| Allow empty value | |
| Style | |
| Explode | |
| Allow Reserved | |
| example | |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Format | |
| Title | |
| Description | |
| Required | |
| Deprecated | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Enum | |
| Faker function | |
| example (deprecated) | |
| nullable | |
| readOnly | |
| writeOnly | |
| xml | |
| externalDocs | |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Field | Type | Req | Key | Description | Comments |
| application/json | media | false |
| Property | Value |
| Name | requestBody |
| Technical name | |
| Comments | |
| Type | requestBody |
| Required | true |
| Description | Updated user object |
| extensions |
| Field | Type | Req | Key | Description | Comments |
| schema | reference | false | |||
| examples | object | false | |||
| encoding | object | false |
| Property | Value |
| Name | application/json |
| Activated | true |
| Description | |
| Comments | |
| example | |
| Type | media |
| extensions |
| Property | Value |
| Name | schema |
| Technical name | |
| Activated | true |
| Reference type | model |
| Reference description |
| Property | Value |
| Name | examples |
| Technical name | examples |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | encoding |
| Technical name | encoding |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | callbacks |
| Technical name | |
| Type | operationObject |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "put",
"description": "This can only be done by the logged in user.",
"properties": {
"parameters": {
"type": "array",
"title": "parameters",
"additionalItems": true,
"items": {
"type": "object",
"description": "name that need to be updated",
"properties": {
"schema": {
"type": "string"
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"requestBody": {
"type": "object",
"description": "Updated user object",
"properties": {
"application/json": {
"type": "object",
"properties": {
"schema": {
"$ref": "#model/definitions/schemas/properties/User"
},
"examples": {
"type": "object",
"title": "examples",
"additionalProperties": false
},
"encoding": {
"type": "object",
"title": "encoding",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"callbacks": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": true,
"required": [
"requestBody"
]
}{
"parameters": [
{
"schema": "Lorem",
"content": {},
"examples": {}
}
],
"requestBody": {
"application/json": {
"schema": {
"id": -94,
"username": "Lorem",
"firstName": "Lorem",
"lastName": "Lorem",
"email": "Lorem",
"password": "Lorem",
"phone": "Lorem",
"userStatus": 8
},
"examples": {},
"encoding": {}
}
},
"callbacks": {}
}| Property | Value |
| Response | 400 |
| Activated | true |
| Id | |
| $ref | |
| Description | Invalid user supplied |
| Resources | /users/{username} |
| Parent request | put |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | Invalid user supplied | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | Invalid user supplied |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "400",
"description": "Invalid user supplied",
"properties": {
"response": {
"type": "object",
"description": "Invalid user supplied",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}| Property | Value |
| Response | 404 |
| Activated | true |
| Id | |
| $ref | |
| Description | User not found |
| Resources | /users/{username} |
| Parent request | put |
| Child response | |
| Comments | |
| extensions | |
| [1] pattern | |
| value | |
| Field | Type | Req | Key | Description | Comments |
| response | response | false | User not found | ||
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Field | Type | Req | Key | Description | Comments |
| headers | object | false | |||
| content | object | false | |||
| links | object | false |
| Property | Value |
| Type | response |
| Comments | |
| Description | User not found |
| extensions |
| Property | Value |
| Name | headers |
| Technical name | headers |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | content |
| Technical name | content |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
| Property | Value |
| Name | links |
| Technical name | links |
| Id | |
| Type | object |
| Title | |
| Description | |
| Required | |
| Min Properties | |
| Max Properties | |
| AdditionalProp Control | Boolean |
| Additional Properties | false |
| Comments |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "404",
"description": "User not found",
"properties": {
"response": {
"type": "object",
"description": "User not found",
"properties": {
"headers": {
"type": "object",
"title": "headers",
"additionalProperties": false
},
"content": {
"type": "object",
"title": "content",
"additionalProperties": false
},
"links": {
"type": "object",
"title": "links",
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}{
"response": {
"headers": {},
"content": {},
"links": {}
}
}